/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2017 by Hitachi Vantara : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/

package org.pentaho.di.core.encryption;

import org.yzbdl.lanius.core.plugins.annotations.ClassLoaderAnno;

import java.lang.annotation.*;

/**
 * Classes annotated with "TwoWayPasswordEncoderPlugin" are automatically
 * recognized and registered as a new data type in the form of a
 * TwoWayPasswordEncoderInterface class.
 *
 * @author matt
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface TwoWayPasswordEncoderPlugin {
    /**
     * @return The ID of the password encoder plugin. You can specify more than one
     * ID in a comma separated format: id1,id2,id3 for deprecation purposes.
     */
    String id();

    String name();

    String description() default "";

    /**
     * @return True if a separate class loader is needed every time this class is
     * instantiated
     */
    @Deprecated
    boolean isSeparateClassLoaderNeeded() default false;

    @Deprecated
    String documentationUrl() default "";

    @Deprecated
    String casesUrl() default "";

    @Deprecated
    String forumUrl() default "";

    @Deprecated
    String classLoaderGroup() default "";

    ClassLoaderAnno classLoaderCfg() default @ClassLoaderAnno;

    /**
     * 插件版本名称, 默认为none
     *
     * @return
     */
    String version() default "none";

    /**
     * 是否是商业版插件
     *
     * @return
     */
    boolean enterprise() default false;
}
